Linc 1.0.0

Operations

• PUB /{organisation_id}/nodes/{node_id}/channels/config

  Operation ID/{organisation_id}/nodes/{node_id}/channels/config

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/channels/config

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/channels/config

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Additional properties are allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/channels/data

  Operation ID/{organisation_id}/nodes/{node_id}/channels/data

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Bulk Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/channels/data

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/channels/data

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  t1

  Expand all

  object

  abc

  thermal

  Expand all

  object

  temperature

  Expand all

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  t2

  Expand all

  object

  abc

  thermal

  Expand all

  object

  temperature

  Expand all

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  t3

  Expand all

  object

  abc

  thermal

  Expand all

  object

  temperature

  Expand all

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  t4

  Expand all

  object

  abc

  thermal

  Expand all

  object

  temperature

  Expand all

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "t1": {
      "thermal": {
        "temperature": {}
      }
    },
    "t2": {
      "thermal": {
        "temperature": {}
      }
    },
    "t3": {
      "thermal": {
        "temperature": {}
      }
    },
    "t4": {
      "thermal": {
        "temperature": {}
      }
    }
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature

  Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

  Operation ID/{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/channels/t1/thermal/temperature

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "temperature"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature

  Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

  Operation ID/{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/channels/t2/thermal/temperature

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "temperature"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature

  Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

  Operation ID/{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/channels/t3/thermal/temperature

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "temperature"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature

  Numeric values representing heat level. Measured in specified units like Celsius, Fahrenheit, or Kelvin.

  Operation ID/{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/channels/t4/thermal/temperature

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "temperature"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/device/config

  Parameters for identification, information and configuration of hardware devices.

  Operation ID/{organisation_id}/nodes/{node_id}/device/config

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/device/config

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/device/config

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Parameters for identification, information and configuration of hardware devices.

  linc

  Expand all

  object

  Hardware related parameters for a Linc node.

  dataplan

  Expand all

  object

  Settings and parameters that define how a Linc node communicates and transfers data, including factors like the frequency of transmissions, storage preferences, platform access and more.

  mode

  Expand all

  string oneOf

  Choice of data handling strategy for a Linc node, influencing both how the data is processed and the associated costs.

  Default value:"platform"

  Adheres to:

  string

  All collected data is stored, analysed, and visualised on the Linc platform, with full programmatic access through API and MQTT.

  Const:"platform"

  Or to:

  string

  Data access only via API or MQTT channels for third-party storage and processing.

  Const:"relay"

  Or to:

  string

  On-premise data handling via the local network. The node has no connection to the Linc server.

  Const:"local"

  reporting_interval

  Expand all

  integer oneOf

  The frequency at which a Linc node sends data, determining how often updates or readings are provided.

  Unit:

  Second (s)

  Duration of reporting interval measured in seconds.

  Default value:60

  Adheres to:

  number

  Data is reported to server at 1 minute intervals.

  Const:60

  Additional properties are allowed.

  label

  string

  [ 1 .. 32 ] characters

  User-specified name or identifier for a Linc node, allowing for easy differentiation within a system or network.

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  Parameters for identification, information and configuration of hardware devices.

  linc

  Expand all

  object

  Hardware related parameters for a Linc node.

  dataplan

  Expand all

  object

  Settings and parameters that define how a Linc node communicates and transfers data, including factors like the frequency of transmissions, storage preferences, platform access and more.

  mode

  Expand all

  string oneOf

  Choice of data handling strategy for a Linc node, influencing both how the data is processed and the associated costs.

  Default value:"platform"

  Adheres to:

  string

  All collected data is stored, analysed, and visualised on the Linc platform, with full programmatic access through API and MQTT.

  Const:"platform"

  Or to:

  string

  Data access only via API or MQTT channels for third-party storage and processing.

  Const:"relay"

  Or to:

  string

  On-premise data handling via the local network. The node has no connection to the Linc server.

  Const:"local"

  reporting_interval

  Expand all

  integer oneOf

  The frequency at which a Linc node sends data, determining how often updates or readings are provided.

  Unit:

  Second (s)

  Duration of reporting interval measured in seconds.

  Default value:1

  Adheres to:

  number

  Data is reported to server at 1 second intervals.

  Const:1

  Or to:

  number

  Data is reported to server at 1 minute intervals.

  Const:60

  Additional properties are allowed.

  label

  string

  [ 1 .. 32 ] characters

  User-specified name or identifier for a Linc node, allowing for easy differentiation within a system or network.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "linc": {
      "dataplan": {
        "mode": "platform",
        "reporting_interval": 60
      },
      "label": "Main electrical panel"
    }
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/device/data

  Parameters for identification, information and configuration of hardware devices.

  Operation ID/{organisation_id}/nodes/{node_id}/device/data

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Bulk Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/device/data

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/device/data

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Parameters for identification, information and configuration of hardware devices.

  linc

  Expand all

  object

  Hardware related parameters for a Linc node.

  dataplan

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/dataplan"

  fw_version

  string

  The software revision number associated with a Linc node, reflecting updates, enhancements, or fixes.

  hw_version

  string

  The version number corresponding to physical components and design of a Linc node. This helps in identifying different production runs or hardware iterations.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/label"

  model

  Expand all

  string oneOf

  Type and variant of a Linc node, indicating its capabilities and features.

  Adheres to:

  string

  Linc Environmental Node

  Const:"env_4ch"

  Additional properties are allowed.

  wifi

  Expand all

  object

  Detailes related to the Wi-Fi module - a hardware component that allows devices to connect to Wi-Fi networks for wireless data communication using standards like 802.11b/g/n.

  mac_address

  string

  A MAC (Media Access Control) address is a unique identifier assigned to network interfaces for communications on a physical network segment. Typically consisting of six pairs of hexadecimal numbers, it's used to ensure devices on a local network can communicate with one another effectively. Unlike IP addresses which can change based on network settings, a device's MAC address is usually fixed and manufacturer-assigned.

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  Parameters for identification, information and configuration of hardware devices.

  cellular

  Expand all

  object

  Details related to a cellular module - a hardware component that connects devices to cellular networks for wireless data transmission using standards like 4G (LTE) and 5G.

  fw_version

  string

  The firmware version of a cellular module represents its embedded software state, dictating functionalities and network compatibility. Updates can introduce new features or fixes. Identifying the version aids in troubleshooting.

  imei

  string

  must match: ^[0-9]{15,17}$

  The IMEI (International Mobile Equipment Identity) is a unique 15-digit number assigned to mobile devices, such as smartphones and tablets. It serves as an identifier for the device and can be used by cellular networks to authenticate the device and permit or deny its access to the network. IMEI is essential for tracking and blacklisting stolen devices, ensuring they cannot be used on any network, even if the SIM card is replaced.

  model

  string

  [ 1 .. 24 ] characters

  The model of a cellular module refers to its distinct version in terms of features, capabilities, and cellular compatibility.

  serial

  string

  [ 1 .. 24 ] characters

  A serial number is a unique identifier assigned by the manufacturer to a cellular module. It helps in tracking, service support, and verifying authenticity.

  Additional properties are allowed.

  linc

  Expand all

  object

  Hardware related parameters for a Linc node.

  dataplan

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/dataplan"

  fw_version

  string

  The software revision number associated with a Linc node, reflecting updates, enhancements, or fixes.

  hw_version

  string

  The version number corresponding to physical components and design of a Linc node. This helps in identifying different production runs or hardware iterations.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/label"

  model

  Expand all

  string oneOf

  Type and variant of a Linc node, indicating its capabilities and features.

  Adheres to:

  string

  Linc Electrical Node

  Const:"elec_16ch"

  Additional properties are allowed.

  wifi

  Expand all

  object

  Detailes related to the Wi-Fi module - a hardware component that allows devices to connect to Wi-Fi networks for wireless data communication using standards like 802.11b/g/n.

  mac_address

  string

  A MAC (Media Access Control) address is a unique identifier assigned to network interfaces for communications on a physical network segment. Typically consisting of six pairs of hexadecimal numbers, it's used to ensure devices on a local network can communicate with one another effectively. Unlike IP addresses which can change based on network settings, a device's MAC address is usually fixed and manufacturer-assigned.

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  Parameters for identification, information and configuration of hardware devices.

  cellular

  Expand all

  object

  Details related to a cellular module - a hardware component that connects devices to cellular networks for wireless data transmission using standards like 4G (LTE) and 5G.

  fw_version

  string

  The firmware version of a cellular module represents its embedded software state, dictating functionalities and network compatibility. Updates can introduce new features or fixes. Identifying the version aids in troubleshooting.

  imei

  string

  must match: ^[0-9]{15,17}$

  The IMEI (International Mobile Equipment Identity) is a unique 15-digit number assigned to mobile devices, such as smartphones and tablets. It serves as an identifier for the device and can be used by cellular networks to authenticate the device and permit or deny its access to the network. IMEI is essential for tracking and blacklisting stolen devices, ensuring they cannot be used on any network, even if the SIM card is replaced.

  model

  string

  [ 1 .. 24 ] characters

  The model of a cellular module refers to its distinct version in terms of features, capabilities, and cellular compatibility.

  serial

  string

  [ 1 .. 24 ] characters

  A serial number is a unique identifier assigned by the manufacturer to a cellular module. It helps in tracking, service support, and verifying authenticity.

  Additional properties are allowed.

  linc

  Expand all

  object

  Hardware related parameters for a Linc node.

  dataplan

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/dataplan"

  fw_version

  string

  The software revision number associated with a Linc node, reflecting updates, enhancements, or fixes.

  hw_version

  string

  The version number corresponding to physical components and design of a Linc node. This helps in identifying different production runs or hardware iterations.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/label"

  model

  Expand all

  string oneOf

  Type and variant of a Linc node, indicating its capabilities and features.

  Adheres to:

  string

  P1 Electrical Node

  Const:"p1"

  Additional properties are allowed.

  wifi

  Expand all

  object

  Detailes related to the Wi-Fi module - a hardware component that allows devices to connect to Wi-Fi networks for wireless data communication using standards like 802.11b/g/n.

  mac_address

  string

  A MAC (Media Access Control) address is a unique identifier assigned to network interfaces for communications on a physical network segment. Typically consisting of six pairs of hexadecimal numbers, it's used to ensure devices on a local network can communicate with one another effectively. Unlike IP addresses which can change based on network settings, a device's MAC address is usually fixed and manufacturer-assigned.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "linc": {
      "dataplan": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/dataplan",
      "fw_version": "v2.1.3",
      "hw_version": "v1.0.3",
      "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/device/data/linc/label",
      "model": "env_4ch"
    },
    "wifi": {
      "mac_address": "00:1A:2B:3C:4D:5E"
    }
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode

  Choice of data handling strategy for a Linc node, influencing both how the data is processed and the associated costs.

  Operation ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/mode

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Choice of data handling strategy for a Linc node, influencing both how the data is processed and the associated costs.

  Default value:"platform"

  Adheres to:

  string

  All collected data is stored, analysed, and visualised on the Linc platform, with full programmatic access through API and MQTT.

  Const:"platform"

  Or to:

  string

  Data access only via API or MQTT channels for third-party storage and processing.

  Const:"relay"

  Or to:

  string

  On-premise data handling via the local network. The node has no connection to the Linc server.

  Const:"local"

  Examples

  Payload

  platform

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval

  The frequency at which a Linc node sends data, determining how often updates or readings are provided.

  Operation ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/device/linc/dataplan/reporting_interval

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  integer oneOf

  The frequency at which a Linc node sends data, determining how often updates or readings are provided.

  Unit:

  Second (s)

  Duration of reporting interval measured in seconds.

  Default value:60

  Adheres to:

  number

  Data is reported to server at 1 minute intervals.

  Const:60

  Or to:

  Expand all

  integer oneOf

  The frequency at which a Linc node sends data, determining how often updates or readings are provided.

  Unit:

  Second (s)

  Duration of reporting interval measured in seconds.

  Default value:1

  Adheres to:

  number

  Data is reported to server at 1 second intervals.

  Const:1

  Or to:

  number

  Data is reported to server at 1 minute intervals.

  Const:60

  Examples

  Payload

  60

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/device/linc/fw_version

  The software revision number associated with a Linc node, reflecting updates, enhancements, or fixes.

  Operation ID/{organisation_id}/nodes/{node_id}/device/linc/fw_version

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/device/linc/fw_version

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/device/linc/fw_version

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  The software revision number associated with a Linc node, reflecting updates, enhancements, or fixes.

  Examples

  Payload

  v2.1.3

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/device/linc/label

  User-specified name or identifier for a Linc node, allowing for easy differentiation within a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/device/linc/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/device/linc/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/device/linc/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 1 .. 32 ] characters

  User-specified name or identifier for a Linc node, allowing for easy differentiation within a system or network.

  Examples

  Payload

  Main electrical panel

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/1/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/10/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/11/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/12/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/13/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/14/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/15/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/16/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/2/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/3/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/4/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/5/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/6/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/7/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/8/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/label

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  Examples

  Payload

  Kitchen

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/phase

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  Examples

  Payload

  line_1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/polarity

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  Examples

  Payload

  forward

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/rating

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor

  Specifies the model of current sensor installed for measurements.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/config/sensor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Examples

  Payload

  ct_30

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/full_load_current

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Examples

  Payload

  12.5

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/demand_distortion/tdd

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "tdd"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/current/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported

  Energy sent back to the grid. Can generate credits or offset costs.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported

  Energy drawn from the grid. Directly impacts electricity bills.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net

  Total active energy produced minus consumed.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/active/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/apparent/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/exported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "exported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/imported

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "imported"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/energy/reactive/net

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "net"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/active

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "active"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/apparent

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "apparent"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/displacement

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "displacement"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/distortion

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "distortion"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/power_factor/total

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "total"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/circuits/9/power/reactive

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "reactive"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous

  The number of cycles per second in an alternating current (AC) system, measured in Hertz (Hz).

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/instantaneous

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "instantaneous"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal

  The standard frequency at which the electrical grid is designed to operate, typically 50 Hz or 60 Hz in various regions.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  integer oneOf

  The standard frequency at which the electrical grid is designed to operate, typically 50 Hz or 60 Hz in various regions.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  Adheres to:

  number

  Grid frequency in most of Europe, Asia, Africa, Australia, and parts of South America.

  Const:50000

  Or to:

  number

  Grid frequency in North America, parts of South America, Japan, South Korea, the Philippines, and a few other territories.

  Const:60000

  Examples

  Payload

  50000

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range

  The continuous frequency range equally above and below the designated grid nominal frequency. A value of 500 mHz would imply a 49.5 to 50.5 Hz nominal range (for a 50 Hz system).

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/nominal_range

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 0 .. 100 ]decimal places <= 3

  The continuous frequency range equally above and below the designated grid nominal frequency. A value of 500 mHz would imply a 49.5 to 50.5 Hz nominal range (for a 50 Hz system).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  Examples

  Payload

  50.01

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient

  Transient values in grid frequency at 200ms intervals correspond to 10 cycles in a 50 Hz system and 12 cycles in a 60 Hz system. These brief deviations are vital for electrical grid stability.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/frequency/transient

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "transient"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal

  Nominal voltage refers to the standard voltage level defined for single or three-phase systems, typically expressed in root mean square (RMS) terms. It represents the voltage that the system is designed to operate at under normal conditions.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/nominal

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  integer oneOf

  Nominal voltage refers to the standard voltage level defined for single or three-phase systems, typically expressed in root mean square (RMS) terms. It represents the voltage that the system is designed to operate at under normal conditions.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  Default value:400000

  Adheres to:

  number

  Single-phase, line-neutral. Typically used for residential and light commercial applications in North America.

  Const:120000

  Or to:

  number

  Single-phase, line-neutral. Typically used for residential and light commercial applications in Europe.

  Const:230000

  Or to:

  number

  Three-phase, line-line. Commonly used for commercial and industrial applications in North America; 120V when measured line-neutral.

  Const:208000

  Or to:

  number

  Three-phase, line-line system commonly used for commercial and industrial applications in Asia and Africa; 220V when measured line-neutral.

  Const:380000

  Or to:

  number

  Three-phase, line-line. Commonly used for commercial and industrial applications in Europe; 230V when measured line-neutral.

  Const:400000

  Or to:

  number

  Three-phase, line-line. Commonly used for commercial and industrial applications in the UK and Australia; 240V when measured line-neutral.

  Const:415000

  Or to:

  number

  Three-phase, line-line system commonly used for commercial and industrial applications in North America; 277V when measured line-neutral.

  Const:480000

  Examples

  Payload

  400000

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/event

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "event"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/dips_swells/limits

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  [property]

  number

  [ 123 .. 123 ]multiple of 123

  abc

  Unit:

  abc (abc)

  abc

  Default value:123

  lower_hysteresis

  number

  [ 0 .. 1000 ]decimal places <= 1

  Lower limit of the hysteresis. For example, at 95%, the dip event will trigger off once above 218.5V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:95

  lower_threshold

  number

  [ 0 .. 1000 ]decimal places <= 1

  Lower limit of the threshold. For example, at 90%, a dip event will trigger on below 207V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:90

  reference

  number

  [ 0 .. 100000000 ]decimal places <= 3

  The reference voltage for determining dips and swells. Typically the nominal grid voltage.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  upper_hysteresis

  number

  [ 0 .. 1000 ]decimal places <= 1

  Upper limit of the hysteresis. For example, at 105%, the swell event will trigger off once below 241.5V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:105

  upper_threshold

  number

  [ 0 .. 1000 ]decimal places <= 1

  Upper limit of the threshold. For example, at 110%, a swell event will trigger on above 253V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:110

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "[property]": 123,
    "lower_hysteresis": 95,
    "lower_threshold": 90,
    "reference": 230.2,
    "upper_hysteresis": 105,
    "upper_threshold": 110
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms

  Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum

  Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental

  THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms

  THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak

  Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_1/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/event

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "event"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/dips_swells/limits

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  [property]

  number

  [ 123 .. 123 ]multiple of 123

  abc

  Unit:

  abc (abc)

  abc

  Default value:123

  lower_hysteresis

  number

  [ 0 .. 1000 ]decimal places <= 1

  Lower limit of the hysteresis. For example, at 95%, the dip event will trigger off once above 218.5V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:95

  lower_threshold

  number

  [ 0 .. 1000 ]decimal places <= 1

  Lower limit of the threshold. For example, at 90%, a dip event will trigger on below 207V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:90

  reference

  number

  [ 0 .. 100000000 ]decimal places <= 3

  The reference voltage for determining dips and swells. Typically the nominal grid voltage.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  upper_hysteresis

  number

  [ 0 .. 1000 ]decimal places <= 1

  Upper limit of the hysteresis. For example, at 105%, the swell event will trigger off once below 241.5V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:105

  upper_threshold

  number

  [ 0 .. 1000 ]decimal places <= 1

  Upper limit of the threshold. For example, at 110%, a swell event will trigger on above 253V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:110

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "[property]": 123,
    "lower_hysteresis": 95,
    "lower_threshold": 90,
    "reference": 230.2,
    "upper_hysteresis": 105,
    "upper_threshold": 110
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms

  Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum

  Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental

  THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms

  THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak

  Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_2/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/crest_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "crest_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/event

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "event"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/dips_swells/limits

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  [property]

  number

  [ 123 .. 123 ]multiple of 123

  abc

  Unit:

  abc (abc)

  abc

  Default value:123

  lower_hysteresis

  number

  [ 0 .. 1000 ]decimal places <= 1

  Lower limit of the hysteresis. For example, at 95%, the dip event will trigger off once above 218.5V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:95

  lower_threshold

  number

  [ 0 .. 1000 ]decimal places <= 1

  Lower limit of the threshold. For example, at 90%, a dip event will trigger on below 207V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:90

  reference

  number

  [ 0 .. 100000000 ]decimal places <= 3

  The reference voltage for determining dips and swells. Typically the nominal grid voltage.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  upper_hysteresis

  number

  [ 0 .. 1000 ]decimal places <= 1

  Upper limit of the hysteresis. For example, at 105%, the swell event will trigger off once below 241.5V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:105

  upper_threshold

  number

  [ 0 .. 1000 ]decimal places <= 1

  Upper limit of the threshold. For example, at 110%, a swell event will trigger on above 253V on a 230V reference.

  Unit:

  Percent (%)

  abc

  Default value:110

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "[property]": 123,
    "lower_hysteresis": 95,
    "lower_threshold": 90,
    "reference": 230.2,
    "upper_hysteresis": 105,
    "upper_threshold": 110
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms

  Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum

  Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/spectrum

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "centroid",
      "range",
      "magnitude"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental

  THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/fundamental

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "fundamental"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms

  THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/thd/rms

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rms"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak

  Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/phases/line_3/waveform_peak

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "waveform_peak"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor

  Voltage Unbalance Factor (VUF) in a three-phase system quantifies the deviation among the RMS values of the three phases. It is calculated as the ratio of the maximum deviation from the average voltage to the average voltage itself, expressed as a percentage. Higher VUF values indicate a greater imbalance in the system.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/ac/voltage/unbalance_factor

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "unbalance_factor"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/config

  Parameters related to electrical systems.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/config

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/config

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/config

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Parameters related to electrical systems.

  ac

  Expand all

  object

  AC (Alternating Current), common in power grids, facilitate the long-distance transmission of electricity and is the standard for household and commercial electrical outlets.

  circuits

  Expand all

  object

  An electrical circuit in an AC system provides a path for the flow of electric current. Each circuit is associated to a voltage phase (L1, L2, L3) or to Neutral (N).

  1

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  2

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  3

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  4

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  5

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  6

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  7

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  8

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  9

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  10

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  11

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  12

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  13

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  14

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  15

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  16

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  [ 0 .. 32 ] characters

  User-specified name or identifier for a channel, allowing for easy differentiation of circuits in a system or network.

  phase

  Expand all

  string oneOf

  The phase designation (L1, L2, L3 or N) in an AC system indicates the specific limb of the three-phase system to which a circuit is connected.

  Default value:"line_1"

  Adheres to:

  string

  Also referred to as Phase 1, present in both single-phase and three-phase systems. Typically brown as per the IEC standard.

  Const:"line_1"

  Or to:

  string

  Also referred to as Phase 2 in a three-phase system. Typically black as per the IEC standard.

  Const:"line_2"

  Or to:

  string

  Also referred to as Phase 3 in a three-phase system. Typically grey as per the IEC standard.

  Const:"line_3"

  Or to:

  string

  Conductor that carries unbalanced current; provides return path to source. Typically blue as per the IEC standard.

  Const:"neutral"

  polarity

  Expand all

  string oneOf

  Signifies the direction of current flow in the circuit. Generally, in bidirectional circuits, positive polarity indicates current flow from source to load. Negative polarity signifies current flow from load to source. Essential for accurate energy accounting.

  Default value:"forward"

  Adheres to:

  string

  Current flows in the same direction as the arrow on the sensor, usually from source to load.

  Const:"forward"

  Or to:

  string

  Current flows in the direction opposite to the arrow on the sensor, necessitating reversal to adjust for correct data.

  Const:"reverse"

  rating

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Specifies the maximum current a circuit can handle. Crucial for ensuring safe and efficient circuit operation.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  sensor

  Expand all

  string oneOf

  Specifies the model of current sensor installed for measurements.

  Adheres to:

  string

  Linc 30A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (3A to 36A).

  Const:"ct_30"

  Or to:

  string

  Linc 50A CT (Current Transformer). Clamp-on design with ⌀10mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (5A to 60A).

  Const:"ct_50"

  Or to:

  string

  Linc 100A CT (Current Transformer). Clamp-on design with ⌀16mm window and 1.2m cable. Accuracy of ±0.5% between 10% and 120% of rated current (10A to 120A).

  Const:"ct_100"

  Or to:

  string

  Linc 200A CT (current transformer). Clamp-on design with ⌀[Specify size] window and [Specify cable length]. Accuracy of ±0.5% between 20A and 240A (10-120% of rated current).

  Const:"ct_200"

  Or to:

  string

  Linc 400A CT (Current Transformer). Clamp-on design with ⌀36mm window and 2.0m cable. Accuracy of ±0.5% between 10% and 120% of rated current (40A to 480A).

  Const:"ct_400"

  Or to:

  string

  Linc 1500A RC (Rogowski Coil). Flexible, clamp-on design with ⌀70mm window and 2m cable. Accuracy Class 0.5 as per IEC 61869-2 with ±0.2% linearity between 1% and 120% (15A to 1800A). Positional error less than 1% of reading.

  Const:"rc_1500"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Full-load current is the maximum current a system or device draws when operating at full capacity. This user-specified value is usually provided by the system manufacturer.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  frequency

  Expand all

  object

  The number of cycles per second in an alternating current (AC) system, measured in Hertz (Hz).

  nominal

  Expand all

  integer oneOf

  The standard frequency at which the electrical grid is designed to operate, typically 50 Hz or 60 Hz in various regions.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  Adheres to:

  number

  Grid frequency in most of Europe, Asia, Africa, Australia, and parts of South America.

  Const:50000

  Or to:

  number

  Grid frequency in North America, parts of South America, Japan, South Korea, the Philippines, and a few other territories.

  Const:60000

  nominal_range

  number

  [ 0 .. 100 ]decimal places <= 3

  The continuous frequency range equally above and below the designated grid nominal frequency. A value of 500 mHz would imply a 49.5 to 50.5 Hz nominal range (for a 50 Hz system).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  Additional properties are allowed.

  voltage

  Expand all

  object

  Voltage in an AC system is the electric potential difference between two points in the circuit. It oscillates between positive and negative values and can be measured as line-to-line (L-L) or line-to-neutral (L-N).

  nominal

  Expand all

  integer oneOf

  Nominal voltage refers to the standard voltage level defined for single or three-phase systems, typically expressed in root mean square (RMS) terms. It represents the voltage that the system is designed to operate at under normal conditions.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  Default value:400000

  Adheres to:

  number

  Single-phase, line-neutral. Typically used for residential and light commercial applications in North America.

  Const:120000

  Or to:

  number

  Single-phase, line-neutral. Typically used for residential and light commercial applications in Europe.

  Const:230000

  Or to:

  number

  Three-phase, line-line. Commonly used for commercial and industrial applications in North America; 120V when measured line-neutral.

  Const:208000

  Or to:

  number

  Three-phase, line-line system commonly used for commercial and industrial applications in Asia and Africa; 220V when measured line-neutral.

  Const:380000

  Or to:

  number

  Three-phase, line-line. Commonly used for commercial and industrial applications in Europe; 230V when measured line-neutral.

  Const:400000

  Or to:

  number

  Three-phase, line-line. Commonly used for commercial and industrial applications in the UK and Australia; 240V when measured line-neutral.

  Const:415000

  Or to:

  number

  Three-phase, line-line system commonly used for commercial and industrial applications in North America; 277V when measured line-neutral.

  Const:480000

  phases

  Expand all

  object

  A voltage phase refers to one of the three AC voltage waveforms (L1, L2, L3) generated 120 degrees apart. All phase parameters are measured relative to neutral (L-N).

  line_1

  Expand all

  object

  dips_swells

  Expand all

  object

  Short-term changes in voltage level, below or above the normal. For example, a dip to 180V or a swell to 260V on a 230V line.

  limits

  Expand all

  object

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  Additional properties are NOT allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  line_2

  Expand all

  object

  dips_swells

  Expand all

  object

  Short-term changes in voltage level, below or above the normal. For example, a dip to 180V or a swell to 260V on a 230V line.

  limits

  Expand all

  object

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  Additional properties are NOT allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  line_3

  Expand all

  object

  dips_swells

  Expand all

  object

  Short-term changes in voltage level, below or above the normal. For example, a dip to 180V or a swell to 260V on a 230V line.

  limits

  Expand all

  object

  Prescribed bounds for acceptable voltage variation. An event triggers on when voltage exceeds the upper and lower thresholds relative to the reference voltage. It triggers off when voltage returns to within hysteresis limits.

  Additional properties are NOT allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "ac": {
      "circuits": {
        "1": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "2": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "3": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "4": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "5": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "6": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "7": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "8": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "9": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "10": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "11": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "12": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "13": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "14": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "15": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        },
        "16": {
          "config": {
            "label": "Kitchen",
            "phase": "line_1",
            "polarity": "forward",
            "rating": 12.5,
            "sensor": "ct_30"
          },
          "current": {
            "demand_distortion": {
              "full_load_current": 12.5
            }
          }
        }
      },
      "frequency": {
        "nominal": 50000,
        "nominal_range": 50.01
      },
      "voltage": {
        "nominal": 400000,
        "phases": {
          "line_1": {
            "dips_swells": {
              "limits": {}
            }
          },
          "line_2": {
            "dips_swells": {
              "limits": {}
            }
          },
          "line_3": {
            "dips_swells": {
              "limits": {}
            }
          }
        }
      }
    }
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/electrical/data

  Parameters related to electrical systems.

  Operation ID/{organisation_id}/nodes/{node_id}/electrical/data

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Bulk Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/electrical/data

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/electrical/data

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Parameters related to electrical systems.

  ac

  Expand all

  object

  AC (Alternating Current), common in power grids, facilitate the long-distance transmission of electricity and is the standard for household and commercial electrical outlets.

  circuits

  Expand all

  object

  An electrical circuit in an AC system provides a path for the flow of electric current. Each circuit is associated to a voltage phase (L1, L2, L3) or to Neutral (N).

  1

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  2

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  3

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  4

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  5

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  6

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  7

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  8

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  9

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  10

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  11

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  12

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  13

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  14

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  15

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  16

  Expand all

  object

  A channel refers to a specific circuit in a multi-channel measurement system.

  config

  Expand all

  object

  Configuration parameters for an individual circuit, including its phase assignment, polarity, rating and sensor selection.

  label

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/label"

  phase

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/phase"

  polarity

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/polarity"

  rating

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/rating"

  sensor

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/sensor"

  Additional properties are allowed.

  current

  Expand all

  object

  Measures related to the the flow of electric charge in a circuit.

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  demand_distortion

  Expand all

  object

  Demand Distortion measures harmonic current as a percentage of fixed full-load current, unlike THD-I, which is based on fluctuating fundamental or RMS currents. Expressed as a percentage of max ssytem current, it helps evaluate system inefficiencies and prevent equipment wear.

  full_load_current

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/current/demand_distortion/full_load_current"

  tdd

  number

  [ 0 .. 100 ]decimal places <= 3

  TDD (Total Demand Distortion) measures harmonic current as a percentage of full-load current. More stable and equipment-specific than THD-I, better for evaluating system performance.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  rms

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Current RMS (Root Mean Square) is the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of current in an AC system.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  spectrum

  Expand all

  array<object>

  Representation of current RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-I (Total Harmonic Distortion in Current) indicates how much the current waveform strays from a sine wave. Often caused by demand-side nonlinear loads. Can result in overheating and equipment stress.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-I based on Fundamental frequency. Useful for targeting specific harmonics causing issues in a system.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-I based on RMS. Shows distortion in current flow. High values can cause heating in conductors.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Maximum value of the current within individual cycles during a 1-second timeframe. In a 10A AC line, the nominal peak current may reach 14.14A.

  Unit:

  Ampere (Ampere (A) is the unit of electric current in AC systems, indicating the flow of charge.)

  A

  Additional properties are allowed.

  energy

  Expand all

  object

  Energy in an AC system quantifies the total work done over a period. It encompasses active, reactive, and apparent energy components.

  active

  Expand all

  object

  Active energy represents the actual work done. Directly impacts billing as utilities usually charge based on this consumption.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy sent back to the grid. Can generate credits or offset costs.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Energy drawn from the grid. Directly impacts electricity bills.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total active energy produced minus consumed.

  Unit:

  Watt-hour (Wh)

  Watt-hour (Wh) units measure energy doing useful work, directly linked to billing.

  Additional properties are allowed.

  apparent

  Expand all

  object

  Apparent energy is the vector sum of active and reactive energy. Although not directly billed, high levels may necessitate system upgrades, leading to additional costs. Generally quantified in kilovolt-ampere-hours (kVAh).

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy sent back to the grid. Rarely credited, but informs system's export capacity. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Apparent energy drawn from the grid. Can be a factor in demand or capacity charges. Typically measured in kVAh.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total apparent energy produced minus consumed. Useful for system capacity planning.

  Unit:

  Volt-Ampere hour (VAh)

  Volt-Ampere hour (VAh) units measure the vector sum of active and reactive energy, provides overall view of energy flow.

  Additional properties are allowed.

  reactive

  Expand all

  object

  Reactive energy signifies energy stored and released back to the grid. Some utilities may charge for excessive reactive energy since it can burden the system without doing useful work.

  exported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy sent back to the grid. Not usually credited. May indicate over-compensation of power factor correction devices.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  imported

  number

  [ 0 .. 1000000000000000 ]decimal places <= 3

  Reactive energy drawn from the grid to maintain magnetic fields in inductive loads. Could lead to power factor penalties.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  net

  number

  [ -1000000000000000 .. 1000000000000000 ]decimal places <= 3

  Total reactive energy produced minus consumed. Can indicate wasted power and potential system inefficiency.

  Unit:

  Volt-Ampere Reactive hour (VARh)

  Volt-Ampere Reactive hour (VARh) units measure energy stored and returned to the system.

  Additional properties are allowed.

  Additional properties are allowed.

  power

  Expand all

  object

  Power in an AC system is the rate of energy transfer, affected by both voltage and current. It consists of active, reactive, and apparent components, each measured in specific units.

  active

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Active power is the real power that does actual work, like turning a motor or powering a device. Measured in watts (W), it's the primary factor for energy billing.

  Unit:

  Watt (W)

  Watt (W) is the unit of active power in AC electrical systems, used to quantify the rate of energy transfer.

  apparent

  number

  [ 0 .. 10000000 ]decimal places <= 6

  Apparent power represents the total power flow in an AC circuit, combining active and reactive power. Measured in volt-amperes (VA), it's useful for sizing equipment and wiring but doesn't reflect real energy use.

  Unit:

  Volt-Ampere (VA)

  Volt-Ampere (VA) is the unit for apparent power in an AC electrical system.

  power_factor

  Expand all

  object

  Power factor measures the efficiency of converting electrical power to useful work, combining both the phase displacement between current and voltage and harmonic distortion. A low power factor necessitates larger network infrastructure to manage inefficiencies.

  displacement

  number

  [ -1 .. 1 ]decimal places <= 6

  Indicates the phase angle difference between current and voltage, affecting real power transfer. Ideal in purely resistive circuits, it may degrade in systems with inductive or capacitive elements, requiring phase-correcting equipment.

  Unit:

  Displacement Power Factor (undefined)

  Cosine of angle between current and voltage waveforms.

  distortion

  number

  [ -1 .. 1 ]decimal places <= 6

  Reflects the impact of harmonics on system efficiency. A poor distortion power factor can lead to overheating and damage to equipment, necessitating harmonic filters for correction.

  Unit:

  Distortion Power Factor (undefined)

  Dimensionless measure of how harmonics distort the AC waveforms.

  total

  number

  [ -1 .. 1 ]decimal places <= 6

  The overall measure of electrical system efficiency, considering both displacement and distortion factors. A low total power factor may require infrastructure upgrades or power factor correction devices.

  Unit:

  Power Factor (λ)

  Dimensionless ratio of active power (W) to apparent power (VA) in an AC circuit. It combines both displacement and distortion effects.

  Additional properties are allowed.

  reactive

  number

  [ -10000000 .. 10000000 ]decimal places <= 6

  Reactive power doesn't do work but supports the magnetic and electric fields in AC systems. Measured in volt-amperes reactive (VAR), it's essential for system stability but can lead to inefficiencies.

  Unit:

  Volt-Ampere Reactive (VAR)

  Volt-Ampere Reactive (VAR) measures reactive power in AC systems. Important in systems with inductive loads like motors and transformers; excessive VAR can lead to higher utility charges and necessitates more robust infrastructure.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  frequency

  Expand all

  object

  The number of cycles per second in an alternating current (AC) system, measured in Hertz (Hz).

  instantaneous

  number

  [ 0 .. 100 ]decimal places <= 3

  The number of cycles per second in an alternating current (AC) system, measured in Hertz (Hz).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  nominal

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/frequency/nominal"

  nominal_range

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/frequency/nominal_range"

  transient

  Expand all

  object

  Transient values in grid frequency at 200ms intervals correspond to 10 cycles in a 50 Hz system and 12 cycles in a 60 Hz system. These brief deviations are vital for electrical grid stability.

  min

  number

  [ 0 .. 100 ]decimal places <= 3

  The highest transient value within a 1-second timeframe.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  std_dev

  number

  [ 0 .. 100 ]decimal places <= 3

  The measure of dispersion in transient values within a 1-second timeframe, indicating how much they deviate from the mean.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  Additional properties are NOT allowed.

  Additional properties are allowed.

  voltage

  Expand all

  object

  Voltage in an AC system is the electric potential difference between two points in the circuit. It oscillates between positive and negative values and can be measured as line-to-line (L-L) or line-to-neutral (L-N).

  nominal

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/nominal"

  phases

  Expand all

  object

  A voltage phase refers to one of the three AC voltage waveforms (L1, L2, L3) generated 120 degrees apart. All phase parameters are measured relative to neutral (L-N).

  line_1

  Expand all

  object

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  dips_swells

  Expand all

  object

  Short-term changes in voltage level, below or above the normal. For example, a dip to 180V or a swell to 260V on a 230V line.

  event

  Expand all

  object

  duration

  any

  Unit:

  Second (s)

  abc

  magnitude

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Measurement of the severity of the event. Represented as the minimum (dip) or maximum (swell) value during the event.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  start_time

  integer

  The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  Additional properties are NOT allowed.

  limits

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/phases/line_1/dips_swells/limits"

  Additional properties are allowed.

  rms

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  spectrum

  Expand all

  array<object>

  Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-V (Total Harmonic Distortion in Voltage) measures how much voltage waveform deviates from a pure sine wave. High levels usually originate from supply distortions or nonlinear loads. Can affect sensitive devices.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  Additional properties are allowed.

  line_2

  Expand all

  object

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  dips_swells

  Expand all

  object

  Short-term changes in voltage level, below or above the normal. For example, a dip to 180V or a swell to 260V on a 230V line.

  event

  Expand all

  object

  duration

  any

  Unit:

  Second (s)

  abc

  magnitude

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Measurement of the severity of the event. Represented as the minimum (dip) or maximum (swell) value during the event.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  start_time

  integer

  The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  Additional properties are NOT allowed.

  limits

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/phases/line_2/dips_swells/limits"

  Additional properties are allowed.

  rms

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  spectrum

  Expand all

  array<object>

  Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-V (Total Harmonic Distortion in Voltage) measures how much voltage waveform deviates from a pure sine wave. High levels usually originate from supply distortions or nonlinear loads. Can affect sensitive devices.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  Additional properties are allowed.

  line_3

  Expand all

  object

  crest_factor

  number

  [ 0 .. 1000 ]decimal places <= 3

  Ratio of the peak value to the RMS value of a waveform. A pure sine wave has a crest factor of 1.414.

  Unit:

  Crest factor (undefined)

  Crest factor is a dimensionless ratio between the peak and RMS values of a waveform.

  dips_swells

  Expand all

  object

  Short-term changes in voltage level, below or above the normal. For example, a dip to 180V or a swell to 260V on a 230V line.

  event

  Expand all

  object

  duration

  any

  Unit:

  Second (s)

  abc

  magnitude

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Measurement of the severity of the event. Represented as the minimum (dip) or maximum (swell) value during the event.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  start_time

  integer

  The Unix epoch (or Unix time or POSIX time or Unix timestamp) is the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT).

  Additional properties are NOT allowed.

  limits

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/phases/line_3/dips_swells/limits"

  Additional properties are allowed.

  rms

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Voltage RMS (Root Mean Square), the square root of the arithmetic mean of the squared values of a periodic waveform. It represents the effective value of voltage in an AC system.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  spectrum

  Expand all

  array<object>

  Representation of voltage RMS in the frequency domain, showing distribution across various frequency components.

  centroid

  number

  [ 0 .. 1000000 ]decimal places <= 3

  Central value for a given frequency component range. For instance, a value of 100000 mHz implies a frequency component centered at 100Hz.

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  magnitude

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Magnitude of RMS allocated to a specific frequency component.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  range

  number

  [ 0 .. 100 ]decimal places <= 3

  The frequency component defined by a range value equally above and below the centroid. For instance, a value of 5 Hz would imply a 95 to 105 Hz frequency component (around a 100 Hz centroid).

  Unit:

  Hertz (Hz)

  Hertz (Hz) measures the frequency of oscillationin the electrical grid, indicating the number of cycles per second. In standard systems, common frequencies are 50 Hz or 60 Hz.

  thd

  Expand all

  object

  THD-V (Total Harmonic Distortion in Voltage) measures how much voltage waveform deviates from a pure sine wave. High levels usually originate from supply distortions or nonlinear loads. Can affect sensitive devices.

  fundamental

  number

  [ 0 .. 10000 ]decimal places <= 3

  THD-V based on fundamental frequency (typically 50 or 60Hz). Focuses on distortion from base AC frequency. Useful for filtering decisions.

  Unit:

  Percent (%)

  abc

  rms

  number

  [ 0 .. 100 ]decimal places <= 3

  THD-V based on RMS. Indicates quality of voltage. High values can affect sensitive equipment.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  waveform_peak

  number

  [ 0 .. 100000000 ]decimal places <= 3

  Maximum value of the voltage within individual cycles during a 1-second timeframe. In a 230V AC line, the nominal peak voltage may reach 325 V.

  Unit:

  Volt (V)

  Volt (V) is a unit of electric potential difference between two points in an AC circuit.

  Additional properties are allowed.

  Additional properties are allowed.

  unbalance_factor

  number

  [ 0 .. 100 ]decimal places <= 3

  Voltage Unbalance Factor (VUF) in a three-phase system quantifies the deviation among the RMS values of the three phases. It is calculated as the ratio of the maximum deviation from the average voltage to the average voltage itself, expressed as a percentage. Higher VUF values indicate a greater imbalance in the system.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "ac": {
      "circuits": {
        "1": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/1/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "2": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/2/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "3": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/3/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "4": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/4/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "5": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/5/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "6": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/6/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "7": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/7/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "8": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/8/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "9": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/9/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "10": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/10/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "11": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/11/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "12": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/12/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "13": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/13/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "14": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/14/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "15": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/15/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        },
        "16": {
          "config": {
            "label": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/label",
            "phase": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/phase",
            "polarity": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/polarity",
            "rating": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/rating",
            "sensor": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/config/sensor"
          },
          "current": {
            "crest_factor": 1.41,
            "demand_distortion": {
              "full_load_current": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/circuits/16/current/demand_distortion/full_load_current",
              "tdd": 4.2
            },
            "rms": 12.5,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 12.5,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 12.5
          },
          "energy": {
            "active": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "apparent": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            },
            "reactive": {
              "exported": 134.3,
              "imported": 134.3,
              "net": 187.4
            }
          },
          "power": {
            "active": 1482.6,
            "apparent": 1739.4,
            "power_factor": {
              "displacement": 0.91,
              "distortion": 0.91,
              "total": 0.91
            },
            "reactive": 1482.6
          }
        }
      },
      "frequency": {
        "instantaneous": 50.01,
        "nominal": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/frequency/nominal",
        "nominal_range": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/frequency/nominal_range",
        "transient": {
          "min": 50.01,
          "std_dev": 50.01
        }
      },
      "voltage": {
        "nominal": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/nominal",
        "phases": {
          "line_1": {
            "crest_factor": 1.41,
            "dips_swells": {
              "event": {
                "duration": null,
                "magnitude": 230.2,
                "start_time": 0
              },
              "limits": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/phases/line_1/dips_swells/limits"
            },
            "rms": 230.2,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 230.2,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 230.2
          },
          "line_2": {
            "crest_factor": 1.41,
            "dips_swells": {
              "event": {
                "duration": null,
                "magnitude": 230.2,
                "start_time": 0
              },
              "limits": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/phases/line_2/dips_swells/limits"
            },
            "rms": 230.2,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 230.2,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 230.2
          },
          "line_3": {
            "crest_factor": 1.41,
            "dips_swells": {
              "event": {
                "duration": null,
                "magnitude": 230.2,
                "start_time": 0
              },
              "limits": "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/electrical/data/ac/voltage/phases/line_3/dips_swells/limits"
            },
            "rms": 230.2,
            "spectrum": [
              {
                "centroid": 100,
                "magnitude": 230.2,
                "range": 50.01
              }
            ],
            "thd": {
              "fundamental": 12.7,
              "rms": 4.2
            },
            "waveform_peak": 230.2
          }
        },
        "unbalance_factor": 1.3
      }
    }
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid

  The ICCID (Integrated Circuit Card Identifier) is a unique serial number assigned to each SIM card used in mobile devices. Typically 19 to 20 digits long, it's used to identify the SIM internationally, helping operators and service providers manage their subscribers. The ICCID provides information about the card's origin, network, and other specific details.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/iccid

  Payload

  string

  must match: /^[0-9]{18,22}$/

  The ICCID (Integrated Circuit Card Identifier) is a unique serial number assigned to each SIM card used in mobile devices. Typically 19 to 20 digits long, it's used to identify the SIM internationally, helping operators and service providers manage their subscribers. The ICCID provides information about the card's origin, network, and other specific details.

  Examples

  Payload

  string

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc

  The MCC (Mobile Country Code) is a three-digit number used to identify a mobile device's country of origin or the country of the cellular network it's operating in. It's a component of the IMSI (International Mobile Subscriber Identity) and is essential for international roaming, ensuring the device can connect to networks outside its home country.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mcc

  Payload

  string

  must match: /^[0-9]{3}$/

  The MCC (Mobile Country Code) is a three-digit number used to identify a mobile device's country of origin or the country of the cellular network it's operating in. It's a component of the IMSI (International Mobile Subscriber Identity) and is essential for international roaming, ensuring the device can connect to networks outside its home country.

  Examples

  Payload

  string

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc

  The MNC (Mobile Network Code) is a two or three-digit number used in conjunction with the Mobile Country Code (MCC) to identify a specific mobile network operator within a country. Together, the MCC and MNC form a unique identifier for cellular networks, allowing devices to connect to the correct local network and ensuring proper routing of communications, especially in international roaming scenarios.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/mnc

  Payload

  string

  must match: /^[0-9]{2,3}$/

  The MNC (Mobile Network Code) is a two or three-digit number used in conjunction with the Mobile Country Code (MCC) to identify a specific mobile network operator within a country. Together, the MCC and MNC form a unique identifier for cellular networks, allowing devices to connect to the correct local network and ensuring proper routing of communications, especially in international roaming scenarios.

  Examples

  Payload

  string

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin

  The MSIN (Mobile Subscription Identification Number) is a unique number typically consisting of 9 to 10 digits, representing an individual subscriber in a mobile network. It's the last part of the IMSI (International Mobile Subscriber Identity) and, when combined with the MCC (Mobile Country Code) and MNC (Mobile Network Code), creates a unique identifier for each mobile user globally. MSIN ensures individual subscribers are distinguished within a specific network operator's service.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/imsi/msin

  Payload

  string

  must match: /^[0-9]{10}$/

  The MSIN (Mobile Subscription Identification Number) is a unique number typically consisting of 9 to 10 digits, representing an individual subscriber in a mobile network. It's the last part of the IMSI (International Mobile Subscriber Identity) and, when combined with the MCC (Mobile Country Code) and MNC (Mobile Network Code), creates a unique identifier for each mobile user globally. MSIN ensures individual subscribers are distinguished within a specific network operator's service.

  Examples

  Payload

  string

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/mode

  Cellular modes like Cat M1, Cat NB2 refer to different categories of 4G (LTE) and 5G technologies.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/mode

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/connection/mode

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/mode

  Payload

  Expand all

  string oneOf

  Cellular modes like Cat M1, Cat NB2 refer to different categories of 4G (LTE) and 5G technologies.

  Adheres to:

  string

  LTE-M, also known as Cat-M1, is a low-power wide-area (LPWA) technology tailored for IoT applications. Offering data rates up to 1.12 Mbps uplink and 589 kbps downlink, it ensures reliable connectivity, especially in challenging environments like deep inside buildings.

  Const:"cat_m1"

  Or to:

  string

  NB2, an evolution of NB-IoT, is a low-power wide-area (LPWA) technology designed specifically for IoT devices. With data rates around 150 kbps uplink and 136 kbps uplink, it's optimized for minimal bandwidth applications and offers excellent penetration for connectivity in challenging locations, such as deep within buildings.

  Const:"cat_nb2"

  Examples

  Payload

  cat_m1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/connection/status

  The connection status refers to whether or not a connection is enabled.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/status

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/connection/status

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/connection/status

  Payload

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Examples

  Payload

  enabled

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp

  RSRP (Reference Signal Received Power) gauges the power level of specific LTE reference signals in dBm. Closer to -80 dBm signifies a strong signal, while figures around -100 dBm indicate weak ones. RSRP helps determine LTE cell coverage and connection robustness.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrp

  Payload

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rsrp"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq

  RSRQ (Reference Signal Received Quality) evaluates the quality of LTE reference signals by comparing the received power of a reference signal to the total received power. A value closer to -10 dB suggests superior signal quality, while values nearing -20 dB indicate poorer quality. RSRQ helps understand the LTE signal's relative quality in the context of surrounding interference.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rsrq

  Payload

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rsrq"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/rssi

  Payload

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rssi"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr

  SINR (Signal-to-Interference-plus-Noise Ratio) contrasts the power of a desired signal against the combined power of interference and noise, represented in dB. Higher values, like 20 dB, suggest a better signal quality, whereas values close to 0 dB suggest a compromised signal due to interference. SINR helps gauge LTE connection clarity.

  Operation ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/cellular/signal/sinr

  Payload

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "sinr"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/config

  Parameters related to connectivity and network protocols.

  Operation ID/{organisation_id}/nodes/{node_id}/network/config

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Config

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/config

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/config

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Parameters related to connectivity and network protocols.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  Parameters related to connectivity and network protocols.

  cellular

  Expand all

  object

  Parameters related to cellular network connectiviity.

  connection

  Expand all

  object

  Parameters related to the status and configuration of a network connection.

  apn

  string

  <= 100 characters

  The APN (Access Point Name) is a setting that identifies a cellular data network the node can connect to. It provides the necessary information to connect to the internet and defines the type of service it can access. Cellular providers specify the APN settings for their networks, ensuring users can send and receive data correctly.

  pin

  string

  must match: ^[0-9]{4}$

  The PIN (Personal Identification Number) for a SIM card is a security code, typically 4 to 8 digits long, that protects the card from unauthorized access. When enabled, users must enter the PIN to use the SIM for accessing cellular data. If entered incorrectly multiple times, the SIM locks, requiring a PUK (Personal Unblocking Key) to unlock.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/connectivity/status

  The connection status shows whether or not a device is currently online.

  Operation ID/{organisation_id}/nodes/{node_id}/network/connectivity/status

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/connectivity/status

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/connectivity/status

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The connection status shows whether or not a device is currently online.

  Adheres to:

  string

  Device is connected to server.

  Const:"online"

  Or to:

  string

  Device is disconnected from server.

  Const:"offline"

  Examples

  Payload

  online

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h

  Moving average of the device uptime in the past 6 hours.

  Operation ID/{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/connectivity/uptime/average_6h

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "average_6h"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/data

  Parameters related to connectivity and network protocols.

  Operation ID/{organisation_id}/nodes/{node_id}/network/data

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Bulk Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/data

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/data

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  object

  Parameters related to connectivity and network protocols.

  connectivity

  Expand all

  object

  Parameters related to the status and stability of device connectivity to server.

  status

  Expand all

  string oneOf

  The connection status shows whether or not a device is currently online.

  Adheres to:

  string

  Device is connected to server.

  Const:"online"

  Or to:

  string

  Device is disconnected from server.

  Const:"offline"

  uptime

  Expand all

  object

  The proportion of time that a network device has been connected to server in a given timeframe.

  average_6h

  number

  [ 0 .. 100 ]decimal places <= 1

  Moving average of the device uptime in the past 6 hours.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  Additional properties are allowed.

  linc_mesh

  Expand all

  object

  The Linc Mesh provides internet access throughout a building by relaying data through Linc nodes. It uses the 2.4 GHz frequency for Wi-Fi-like range and speed. It self-routes data across nodes, reducing reliance on central access points and making the connection more resilient.

  connection

  Expand all

  object

  Parameters related to the status and configuration of a network connection.

  hop_count

  number

  [ 1 .. 24 ]multiple of 1

  Hop count in a mesh network refers to the number of intermediate nodes that data must pass through between its originating node and the root node with internet access. It serves as a metric to determine the path's length and potential latency. As the hop count increases, it can impact the overall bandwidth availability and network efficiency due to increased chances of congestion and interference.

  ip_address

  Expand all

  string anyOf

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Can adhere to:

  any

  format: ipv4

  Or to:

  any

  format: ipv6

  parent_node

  string

  must match: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$

  Parent node in a mesh network refers to an immediate upstream node to which another node (typically referred to as the child node) is directly connected. The parent node helps the child node with tasks like routing data, establishing connectivity, or maintaining the network hierarchy within the mesh topology.

  status

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Additional properties are allowed.

  signal

  Expand all

  object

  Parameters related to the strength and quality of a network signal.

  rssi

  number

  [ -128 .. 0 ]multiple of 1

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Unit:

  Decibel-milliwatt (dBm)

  dBm denotes signal strength, measured in decibels relative to one milliwatt.

  Additional properties are allowed.

  Additional properties are allowed.

  wifi

  Expand all

  object

  Wi-Fi is a wireless technology that allows devices to connect to the internet or local networks using radio waves, typically in the 2.4 GHz and 5 GHz bands, without physical cables. It's facilitated by wireless routers that broadcast internet connections to devices like computers, smartphones, and tablets.

  connection

  Expand all

  object

  Parameters related to the status and configuration of a network connection.

  ip_address

  Expand all

  string anyOf

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Can adhere to:

  any

  format: ipv4

  Or to:

  any

  format: ipv6

  status

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Additional properties are allowed.

  signal

  Expand all

  object

  Parameters related to the strength and quality of a network signal.

  rssi

  number

  [ -128 .. 0 ]multiple of 1

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Unit:

  Decibel-milliwatt (dBm)

  dBm denotes signal strength, measured in decibels relative to one milliwatt.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  Parameters related to connectivity and network protocols.

  cellular

  Expand all

  object

  Parameters related to cellular network connectiviity.

  connection

  Expand all

  object

  Parameters related to the status and configuration of a network connection.

  apn

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/network/data/cellular/connection/apn"

  iccid

  string

  must match: ^[0-9]{18,22}$

  The ICCID (Integrated Circuit Card Identifier) is a unique serial number assigned to each SIM card used in mobile devices. Typically 19 to 20 digits long, it's used to identify the SIM internationally, helping operators and service providers manage their subscribers. The ICCID provides information about the card's origin, network, and other specific details.

  imsi

  Expand all

  object

  The IMSI (International Mobile Subscriber Identity) is a unique number associated with every user of a cellular network. It's stored in the SIM card and used to identify the subscriber to the network for services like calls and SMS. Typically 15 digits long, the IMSI is a combination of MCC (mobile country code), MNC (mobile network code), and MSIN (mobile subscriber identification number).

  mcc

  string

  must match: ^[0-9]{3}$

  The MCC (Mobile Country Code) is a three-digit number used to identify a mobile device's country of origin or the country of the cellular network it's operating in. It's a component of the IMSI (International Mobile Subscriber Identity) and is essential for international roaming, ensuring the device can connect to networks outside its home country.

  mnc

  string

  must match: ^[0-9]{2,3}$

  The MNC (Mobile Network Code) is a two or three-digit number used in conjunction with the Mobile Country Code (MCC) to identify a specific mobile network operator within a country. Together, the MCC and MNC form a unique identifier for cellular networks, allowing devices to connect to the correct local network and ensuring proper routing of communications, especially in international roaming scenarios.

  msin

  string

  must match: ^[0-9]{10}$

  The MSIN (Mobile Subscription Identification Number) is a unique number typically consisting of 9 to 10 digits, representing an individual subscriber in a mobile network. It's the last part of the IMSI (International Mobile Subscriber Identity) and, when combined with the MCC (Mobile Country Code) and MNC (Mobile Network Code), creates a unique identifier for each mobile user globally. MSIN ensures individual subscribers are distinguished within a specific network operator's service.

  Additional properties are allowed.

  mode

  Expand all

  string oneOf

  Cellular modes like Cat M1, Cat NB2 refer to different categories of 4G (LTE) and 5G technologies.

  Adheres to:

  string

  LTE-M, also known as Cat-M1, is a low-power wide-area (LPWA) technology tailored for IoT applications. Offering data rates up to 1.12 Mbps uplink and 589 kbps downlink, it ensures reliable connectivity, especially in challenging environments like deep inside buildings.

  Const:"cat_m1"

  Or to:

  string

  NB2, an evolution of NB-IoT, is a low-power wide-area (LPWA) technology designed specifically for IoT devices. With data rates around 150 kbps uplink and 136 kbps uplink, it's optimized for minimal bandwidth applications and offers excellent penetration for connectivity in challenging locations, such as deep within buildings.

  Const:"cat_nb2"

  pin

  string

  format: uri

  Examples values:
  • "/d0c80c56-fd5f-4278-8b10-28959f4daf26/nodes/1004/network/data/cellular/connection/pin"

  status

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Additional properties are allowed.

  signal

  Expand all

  object

  Parameters related to the strength and quality of a network signal.

  rsrp

  number

  [ -128 .. 0 ]multiple of 1

  RSRP (Reference Signal Received Power) gauges the power level of specific LTE reference signals in dBm. Closer to -80 dBm signifies a strong signal, while figures around -100 dBm indicate weak ones. RSRP helps determine LTE cell coverage and connection robustness.

  Unit:

  Decibel-milliwatt (dBm)

  dBm denotes signal strength, measured in decibels relative to one milliwatt.

  rsrq

  number

  [ -32 .. 0 ]multiple of 1

  RSRQ (Reference Signal Received Quality) evaluates the quality of LTE reference signals by comparing the received power of a reference signal to the total received power. A value closer to -10 dB suggests superior signal quality, while values nearing -20 dB indicate poorer quality. RSRQ helps understand the LTE signal's relative quality in the context of surrounding interference.

  Unit:

  Decibel (dB)

  Signal quality and clarity in a wireless network quantified in dB (decibels) on a logarithmic scale.

  rssi

  number

  [ -128 .. 0 ]multiple of 1

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Unit:

  Decibel-milliwatt (dBm)

  dBm denotes signal strength, measured in decibels relative to one milliwatt.

  sinr

  number

  [ -32 .. 32 ]multiple of 1

  SINR (Signal-to-Interference-plus-Noise Ratio) contrasts the power of a desired signal against the combined power of interference and noise, represented in dB. Higher values, like 20 dB, suggest a better signal quality, whereas values close to 0 dB suggest a compromised signal due to interference. SINR helps gauge LTE connection clarity.

  Unit:

  Decibel (dB)

  Signal quality and clarity in a wireless network quantified in dB (decibels) on a logarithmic scale.

  Additional properties are allowed.

  Additional properties are allowed.

  connectivity

  Expand all

  object

  Parameters related to the status and stability of device connectivity to server.

  status

  Expand all

  string oneOf

  The connection status shows whether or not a device is currently online.

  Adheres to:

  string

  Device is connected to server.

  Const:"online"

  Or to:

  string

  Device is disconnected from server.

  Const:"offline"

  uptime

  Expand all

  object

  The proportion of time that a network device has been connected to server in a given timeframe.

  average_6h

  number

  [ 0 .. 100 ]decimal places <= 1

  Moving average of the device uptime in the past 6 hours.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  Additional properties are allowed.

  linc_mesh

  Expand all

  object

  The Linc Mesh provides internet access throughout a building by relaying data through Linc nodes. It uses the 2.4 GHz frequency for Wi-Fi-like range and speed. It self-routes data across nodes, reducing reliance on central access points and making the connection more resilient.

  connection

  Expand all

  object

  Parameters related to the status and configuration of a network connection.

  hop_count

  number

  [ 1 .. 24 ]multiple of 1

  Hop count in a mesh network refers to the number of intermediate nodes that data must pass through between its originating node and the root node with internet access. It serves as a metric to determine the path's length and potential latency. As the hop count increases, it can impact the overall bandwidth availability and network efficiency due to increased chances of congestion and interference.

  ip_address

  Expand all

  string anyOf

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Can adhere to:

  any

  format: ipv4

  Or to:

  any

  format: ipv6

  parent_node

  string

  must match: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$

  Parent node in a mesh network refers to an immediate upstream node to which another node (typically referred to as the child node) is directly connected. The parent node helps the child node with tasks like routing data, establishing connectivity, or maintaining the network hierarchy within the mesh topology.

  status

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Additional properties are allowed.

  signal

  Expand all

  object

  Parameters related to the strength and quality of a network signal.

  rssi

  number

  [ -128 .. 0 ]multiple of 1

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Unit:

  Decibel-milliwatt (dBm)

  dBm denotes signal strength, measured in decibels relative to one milliwatt.

  Additional properties are allowed.

  Additional properties are allowed.

  wifi

  Expand all

  object

  Wi-Fi is a wireless technology that allows devices to connect to the internet or local networks using radio waves, typically in the 2.4 GHz and 5 GHz bands, without physical cables. It's facilitated by wireless routers that broadcast internet connections to devices like computers, smartphones, and tablets.

  connection

  Expand all

  object

  Parameters related to the status and configuration of a network connection.

  ip_address

  Expand all

  string anyOf

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Can adhere to:

  any

  format: ipv4

  Or to:

  any

  format: ipv6

  status

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Additional properties are allowed.

  signal

  Expand all

  object

  Parameters related to the strength and quality of a network signal.

  rssi

  number

  [ -128 .. 0 ]multiple of 1

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Unit:

  Decibel-milliwatt (dBm)

  dBm denotes signal strength, measured in decibels relative to one milliwatt.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:

  Expand all

  object

  Parameters related to connectivity and network protocols.

  connectivity

  Expand all

  object

  Parameters related to the status and stability of device connectivity to server.

  status

  Expand all

  string oneOf

  The connection status shows whether or not a device is currently online.

  Adheres to:

  string

  Device is connected to server.

  Const:"online"

  Or to:

  string

  Device is disconnected from server.

  Const:"offline"

  uptime

  Expand all

  object

  The proportion of time that a network device has been connected to server in a given timeframe.

  average_6h

  number

  [ 0 .. 100 ]decimal places <= 1

  Moving average of the device uptime in the past 6 hours.

  Unit:

  Percent (%)

  abc

  Additional properties are allowed.

  Additional properties are allowed.

  wifi

  Expand all

  object

  Wi-Fi is a wireless technology that allows devices to connect to the internet or local networks using radio waves, typically in the 2.4 GHz and 5 GHz bands, without physical cables. It's facilitated by wireless routers that broadcast internet connections to devices like computers, smartphones, and tablets.

  connection

  Expand all

  object

  Parameters related to the status and configuration of a network connection.

  ip_address

  Expand all

  string anyOf

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Can adhere to:

  any

  format: ipv4

  Or to:

  any

  format: ipv6

  status

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Additional properties are allowed.

  signal

  Expand all

  object

  Parameters related to the strength and quality of a network signal.

  rssi

  number

  [ -128 .. 0 ]multiple of 1

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Unit:

  Decibel-milliwatt (dBm)

  dBm denotes signal strength, measured in decibels relative to one milliwatt.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "connectivity": {
      "status": "online",
      "uptime": {
        "average_6h": 97.2
      }
    },
    "linc_mesh": {
      "connection": {
        "hop_count": 1,
        "ip_address": "192.168.1.10",
        "parent_node": "1009",
        "status": "enabled"
      },
      "signal": {
        "rssi": -62
      }
    },
    "wifi": {
      "connection": {
        "ip_address": "192.168.1.10",
        "status": "enabled"
      },
      "signal": {
        "rssi": -62
      }
    }
  }
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count

  Hop count in a mesh network refers to the number of intermediate nodes that data must pass through between its originating node and the root node with internet access. It serves as a metric to determine the path's length and potential latency. As the hop count increases, it can impact the overall bandwidth availability and network efficiency due to increased chances of congestion and interference.

  Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/hop_count

  Payload

  Expand all

  oneOf

  Adheres to:

  number

  [ 1 .. 24 ]multiple of 1

  Hop count in a mesh network refers to the number of intermediate nodes that data must pass through between its originating node and the root node with internet access. It serves as a metric to determine the path's length and potential latency. As the hop count increases, it can impact the overall bandwidth availability and network efficiency due to increased chances of congestion and interference.

  Examples

  Payload

  1

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/ip_address

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string anyOf

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Can adhere to:

  any

  format: ipv4

  Or to:

  any

  format: ipv6

  Examples

  Payload

  192.168.1.10

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node

  Parent node in a mesh network refers to an immediate upstream node to which another node (typically referred to as the child node) is directly connected. The parent node helps the child node with tasks like routing data, establishing connectivity, or maintaining the network hierarchy within the mesh topology.

  Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/parent_node

  Payload

  Expand all

  oneOf

  Adheres to:

  string

  must match: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$

  Parent node in a mesh network refers to an immediate upstream node to which another node (typically referred to as the child node) is directly connected. The parent node helps the child node with tasks like routing data, establishing connectivity, or maintaining the network hierarchy within the mesh topology.

  Or to:

  string

  must match: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$

  Parent node in a mesh network refers to an immediate upstream node to which another node (typically referred to as the child node) is directly connected. The parent node helps the child node with tasks like routing data, establishing connectivity, or maintaining the network hierarchy within the mesh topology.

  Examples

  Payload

  1006

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status

  The connection status refers to whether or not a connection is enabled.

  Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/connection/status

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Examples

  Payload

  enabled

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Operation ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/linc_mesh/signal/rssi

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rssi"
    ]
  ]
  

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Operation ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/ip_address

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string anyOf

  An IP (Internet Protocol) address is a unique numerical label assigned to devices for identification and location on a network, ensuring they can communicate with each other. It acts as a digital address, allowing data to be directed and received by the correct device on both local networks and the internet.

  Can adhere to:

  any

  format: ipv4

  Or to:

  any

  format: ipv6

  Examples

  Payload

  192.168.1.10

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/wifi/connection/status

  The connection status refers to whether or not a connection is enabled.

  Operation ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/status

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/wifi/connection/status

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/wifi/connection/status

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  string oneOf

  The connection status refers to whether or not a connection is enabled.

  Adheres to:

  string

  Network is enabled.

  Const:"enabled"

  Or to:

  string

  Network is disabled.

  Const:"disabled"

  Examples

  Payload

  enabled

  This example has been generated automatically.

• PUB /{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi

  RSSI (Relative Signal Strength Indicator) measures the power level of received signals in dBm. A value closer to 0, like -60 dBm, indicates a strong received signal, while a lower value, like -90 dBm, indicates a weaker one. Each 3 dBm increase indicates an approximate doubling in power. RSSI helps assess wireless network coverage and connection quality.

  Operation ID/{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi

  Parameters

  Expand all

  node_id

  required

  string

  must match: /^[123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{1}[0123456789ABCDEFGHJKLMNPQRSTUVWXYZ]{3,5}$/uid: node_id

  Some description

  organisation_id

  required

  string

  format: uuiduid: organisation_id

  Some description

  • #Granular Data

  Accepts the following message:

  /{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi

  • application/json

  Message ID/{organisation_id}/nodes/{node_id}/network/wifi/signal/rssi

  Payload

  Expand all

  oneOf

  Adheres to:

  Expand all

  array<array<any>>

  Items:

  Expand all

  array<any>

  Examples

  Payload

  [
    [
      "timestamp",
      "rssi"
    ]
  ]
  

  This example has been generated automatically.